<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:14 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Edge (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="Edge (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Edge.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/graph/api/DirectedGraph.html" title="interface in org.gephi.graph.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/graph/api/EdgeData.html" title="interface in org.gephi.graph.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/graph/api/Edge.html" target="_top">Frames</a></li>
<li><a href="Edge.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.graph.api</div>
<h2 title="Interface Edge" class="title">Interface Edge</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/gephi/graph/api/Attributable.html" title="interface in org.gephi.graph.api">Attributable</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/gephi/graph/api/MetaEdge.html" title="interface in org.gephi.graph.api">MetaEdge</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Edge</span>
extends <a href="../../../../org/gephi/graph/api/Attributable.html" title="interface in org.gephi.graph.api">Attributable</a></pre>
<div class="block">Edge interface. An edge connects two nodes and can be <b>directed</b> or
 not.
 <p>
 If working with several <a href="../../../../org/gephi/graph/api/GraphView.html" title="interface in org.gephi.graph.api"><code>GraphView</code></a>, note that <code>source</code> and
 <code>target</code> are always nodes in the <b>main</b> view. To obtain nodes
 in other views, do:
 <pre>
 GraphView view = ...;
 Node node = node.getNodeData().getNode(view.getViewId());
 </pre></div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Mathieu Bastian</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/graph/api/EdgeData.html" title="interface in org.gephi.graph.api">EdgeData</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/Edge.html#getEdgeData()">getEdgeData</a></strong>()</code>
<div class="block">Returns edge data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/Edge.html#getId()">getId</a></strong>()</code>
<div class="block">Returns the unique identifier of the edge.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/graph/api/Node.html" title="interface in org.gephi.graph.api">Node</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/Edge.html#getSource()">getSource</a></strong>()</code>
<div class="block">Returns the source of the edge.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/graph/api/Node.html" title="interface in org.gephi.graph.api">Node</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/Edge.html#getTarget()">getTarget</a></strong>()</code>
<div class="block">Returns the target of the edge.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/Edge.html#getWeight()">getWeight</a></strong>()</code>
<div class="block">Returns the weight of the edge.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/Edge.html#getWeight(double, double)">getWeight</a></strong>(double&nbsp;low,
         double&nbsp;high)</code>
<div class="block">Returns the weight of the edge for the given time interval.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/Edge.html#isDirected()">isDirected</a></strong>()</code>
<div class="block">Returns <code>true</code> if the edge is directed or <code>false</code> if it's undirected.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/Edge.html#isSelfLoop()">isSelfLoop</a></strong>()</code>
<div class="block">Returns <code>true</code> if edge source and target are the same.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/graph/api/Edge.html#setWeight(float)">setWeight</a></strong>(float&nbsp;weight)</code>
<div class="block">Set the weight of the edge.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.gephi.graph.api.Attributable">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.gephi.graph.api.<a href="../../../../org/gephi/graph/api/Attributable.html" title="interface in org.gephi.graph.api">Attributable</a></h3>
<code><a href="../../../../org/gephi/graph/api/Attributable.html#getAttributes()">getAttributes</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getId()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>int&nbsp;getId()</pre>
<div class="block">Returns the unique identifier of the edge.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the Id of the edge</dd></dl>
</li>
</ul>
<a name="getSource()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSource</h4>
<pre><a href="../../../../org/gephi/graph/api/Node.html" title="interface in org.gephi.graph.api">Node</a>&nbsp;getSource()</pre>
<div class="block">Returns the source of the edge.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the source of the edge</dd></dl>
</li>
</ul>
<a name="getTarget()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTarget</h4>
<pre><a href="../../../../org/gephi/graph/api/Node.html" title="interface in org.gephi.graph.api">Node</a>&nbsp;getTarget()</pre>
<div class="block">Returns the target of the edge.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the target of the edge</dd></dl>
</li>
</ul>
<a name="getWeight()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWeight</h4>
<pre>float&nbsp;getWeight()</pre>
<div class="block">Returns the weight of the edge. Default value is 1.0.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the weight of the edge</dd></dl>
</li>
</ul>
<a name="getWeight(double, double)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWeight</h4>
<pre>float&nbsp;getWeight(double&nbsp;low,
              double&nbsp;high)</pre>
<div class="block">Returns the weight of the edge for the given time interval.
 If the weight is dynamic, it has several values over time. This method
 returns the weight for a particular interval.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>low</code> - the lower interval bound, can be
                  <code>Double.NEGATIVE_INFINITY</code></dd><dd><code>high</code> - the upper interval bound, can be
                  <code>Double.POSITIVE_INFINITY</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the weight of the edge at this [low,high] interval</dd></dl>
</li>
</ul>
<a name="setWeight(float)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWeight</h4>
<pre>void&nbsp;setWeight(float&nbsp;weight)</pre>
<div class="block">Set the weight of the edge.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>weight</code> - the weight of the edge</dd></dl>
</li>
</ul>
<a name="isDirected()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDirected</h4>
<pre>boolean&nbsp;isDirected()</pre>
<div class="block">Returns <code>true</code> if the edge is directed or <code>false</code> if it's undirected.
 Default is directed. Note that value is immutable.<p>
 Special cases:
 <ul><li>If the edge has been created from an <b>undirected</b> graph, returns false.</li>
 <li>If the edge has been created from a <b>directed</b> graph, returns true.</li>
 <li>If the edge has been created from a <b>mixed</b> graph, returns the value set to the
 <code>addEdge()</code> method.</li></ul></div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the edge is directed, <code>false</code> otherwise</dd></dl>
</li>
</ul>
<a name="isSelfLoop()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSelfLoop</h4>
<pre>boolean&nbsp;isSelfLoop()</pre>
<div class="block">Returns <code>true</code> if edge source and target are the same.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the edge is a self-loop, <code>false</code> otherwise</dd></dl>
</li>
</ul>
<a name="getEdgeData()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getEdgeData</h4>
<pre><a href="../../../../org/gephi/graph/api/EdgeData.html" title="interface in org.gephi.graph.api">EdgeData</a>&nbsp;getEdgeData()</pre>
<div class="block">Returns edge data.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>edge data instance</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Edge.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/graph/api/DirectedGraph.html" title="interface in org.gephi.graph.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/graph/api/EdgeData.html" title="interface in org.gephi.graph.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/graph/api/Edge.html" target="_top">Frames</a></li>
<li><a href="Edge.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
